Carbon


SetDialogItemText

Header: Dialogs.h Carbon status: Supported

Sets the text string for static text and editable text fields.

void SetDialogItemText (
    Handle item, 
    ConstStr255Param text
);
item

A handle to an editable text field or static text field. When embedding is on, you should pass in the control handle produced by a call to the function GetDialogItemAsControl. If embedding is not on, pass in the handle produced by the GetDialogItem function.

text

A pointer to a string containing the text to display in the field.

DISCUSSION

The SetDialogItemText function sets and redraws text strings for static text and editable text fields. SetDialogItemText is useful for supplying a default text string—such as a document name—for an editable text field while your application is running.

VERSION NOTES

This function was changed with Appearance Manager 1.0 to support embedding hierarchies.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)